Skip to content

Conversation

@kilfoyle
Copy link
Contributor

As a convention our images are stored in directories named images, but our syntax instructions use img in the example image paths. This caused confusion for one developer so far, so I think it's worth updating our guide.

As a convention our images are stored in a `images` directories, but our syntax instructions use `img` in the example image paths. This caused confusion for one developer so far, so I think it's worth updating our guide.
@kilfoyle kilfoyle requested a review from a team as a code owner April 21, 2025 18:52
@kilfoyle kilfoyle added bug documentation Improvements or additions to documentation and removed bug labels Apr 21, 2025
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kilfoyle I think you'll also need to rename the docs/syntax/img directory to docs/syntax/images and then update any other references to images outside this Markdown file to also point to images instead of img.

@kilfoyle
Copy link
Contributor Author

Thanks @colleenmcginnis! I renamed docs/syntax/img to docs/syntax/images as you suggested, and have fixed up the references to the images in that renamed directory.

@colleenmcginnis colleenmcginnis requested a review from a team April 28, 2025 22:10
Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks @kilfoyle !

@Mpdreamz Mpdreamz merged commit 5d1b5b7 into main May 1, 2025
14 checks passed
@Mpdreamz Mpdreamz deleted the kilfoyle-patch-1 branch May 1, 2025 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants